/*
 * Copyright 2000-2015 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.openapi.util;

import org.jetbrains.annotations.NotNull;

import javax.swing.*;

/**
 * @author Konstantin Bulenkov
 */
public interface ScalableIcon extends Icon {
  /**
   * @return the scale of the icon relative to its origin
   */
  float getScale();

  /**
   * Creates and returns a scaled instance of the icon.
   * The icon is scaled relative to its origin, that is {@code scale(1f)} will
   * return the icon in its original scale.
   *
   * To scale this instance by {@code n} times: {@code scale(n * getScale())}.
   *
   * Note that the methods {@link #getIconWidth()} and {@link #getIconHeight()}
   * should return the scaled size of the icon.
   *
   * @param scaleFactor scale
   * @return scaled icon instance
   */
  @NotNull
  Icon scale(float scaleFactor);
}
